作者:woodburger_821 | 来源:互联网 | 2023-10-14 19:29
篇首语:本文由编程笔记#小编为大家整理,主要介绍了从零开始写一个契约测试工具——数据库设计相关的知识,希望对你有一定的参考价值。
接上文,第一步需要设计我们的表结构,我初步的构想是两张表来装下它,后续肯定会有一些变动,因为我也是一边写工具一边记录的。
设计说明
工具应该有两块内容,第一块是契约的信息,这部分记录的契约的结构体。第二快是子契约,所有具体的值必须由子契约来承载,子契约的内容一旦定义后是不可变更的。而契约工具对消费端和生产端的具体报文内容都由子契约来承载。
环境说明
我使用的是sqlalchemy
这个ORM框架来处理数据库交互的。表结构的代码如下
from sqlalchemy import Column, String, Integer
from sqlalchemy.ext.declarative import declarative_base
BaseModel = declarative_base()
class ContractStructure(BaseModel):
__tablename__ = 'contract_structure'
id = Column(Integer, primary_key=True)
contract_name = Column(String(500), nullable=False)
contract_consumer_body = Column(String(10000), nullable=False)
contract_consumer_keys = Column(String(500), nullable=False)
contract_provider_body = Column(String(5000), nullable=False)
contract_stakeholders = Column(String(500), nullable=False)
contract_child_ids = Column(String(500), nullable=True)
contract_version = Column(Integer, default=1)
contract_last_version = Column(String(1), nullable=False, default='Y')
provider_url = Column(String(100), nullable=True)
class ContractChild(BaseModel):
__tablename__ = 'contract_child'
id = Column(Integer, primary_key=True)
child_id = Column(String(40), nullable=False)
child_name = Column(String(100), nullable=False)
contract_id = Column(Integer)
child_consumer_body = Column(String(10000), nullable=False)
child_provider_body = Column(String(5000), nullable=False)
下面我们一个一个来说明我这样设计的想法
ContractStructure
这个表是用来存放契约结构以及契约的一些相关信息。
契约名称,一般来说方便认识的名字比较好,比如Consumer-Provider
这种。
契约消费者的结构体,也就是consumer
端发起的报文。
契约消费者的结构体的key
,由于契约测试中结构体是不可变的,因此必须要校验consumer
端传过来结构的key
值,用来确保报文结构的一致性
契约生产者的结构体,也就是返回给consumer
端的报文结构
契约的干系人,一旦契约发生变动,程序需要通知的对象
契约子内容的id
契约的版本信息,一旦契约发生变更,那么版本也要对应的变更
标记改版本的契约是否为最新的契约
生产中的url
地址,工具要能够给provider
端发送契约内容,因此需要一个字段来记录url
contract_child
这个表用来存放子契约的内容
子契约对应的名字
所属契约的id
消费端的报文内容
生产端的报文内容
最后
以上,我们定义了工具的表,下面应该做的就是开始写具体的契约类。